Skip to content

feat: update docs#114

Merged
JoE11-y merged 1 commit intomainfrom
stellar-integrations
Apr 13, 2026
Merged

feat: update docs#114
JoE11-y merged 1 commit intomainfrom
stellar-integrations

Conversation

@JoE11-y
Copy link
Copy Markdown
Contributor

@JoE11-y JoE11-y commented Apr 13, 2026 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation
    • Updated architecture documentation to reflect Stellar integration for cross-chain functionality
    • Revised token handling specifications for EVM and Stellar environments
    • Clarified deployment environment descriptions and cross-chain flow examples
    • Updated protocol documentation for native token definitions and contract functions

@JoE11-y JoE11-y merged commit f578385 into main Apr 13, 2026
2 of 3 checks passed
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 13, 2026 •
edited
Loading

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1f568b8e-2e63-41b0-b337-b85fc1852683

📥 Commits

Reviewing files that changed from the base of the PR and between 57c15b8 and 59a0ace.

📒 Files selected for processing (2)
  • architecture.md
  • contracts/README.md
📝 Walkthrough

Walkthrough

Updated architecture.md to reflect cross-chain environment changes from Hedera to Stellar, including contract deployment descriptions, token handling mechanics, and data flow steps. Refined contracts/README.md to clarify native token sentinel address scope and adjust AdManager function documentation qualifiers.

Changes

Cohort / File(s) Summary
Architecture Documentation
architecture.md		 Updated cross-chain environment from Hedera to Stellar; revised contract deployment references (Ethereum Sepolia + Stellar Testnet), token handling mechanics (ETH↔wETH on EVM, XLM direct + SAC/SEP-41 on Stellar), and data flow steps including lock/provision and order-hash insertion on MerkleManager before proving/unlocking.
Contracts Documentation
contracts/README.md		 Refined native token sentinel address (0xEE) scope to EVM only; adjusted AdManager function documentation by removing chain-specific qualifiers from fundAd and withdrawFromAd.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • ProofBridge#3 — Updates to contracts/README.md documentation regarding native token sentinel scope and AdManager function qualifiers modify related documentation semantics.

Suggested reviewers

  • Ugo-X

Poem

🐰 From Hedera's halls to Stellar's bright light,
XLM flows where wETH took flight,
Merkle roots settle with order-hash care,
Cross-chains unite with zero-knowledge flair! ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch stellar-integrations

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@JoE11-y